GetUserToken

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODNameResolver

GetUserToken
The GetUserToken method returns a reference to the descriptor object contained in the specified OpenDoc token.
ODDesc GetUserToken(in ODOSLToken token);
token
A reference to the OpenDoc token from which to extract the descriptor.
return value
A reference to the descriptor object contained inside this token.

DISCUSSION
This method returns the descriptor that represents your private data. You must not dispose of this descriptor; OpenDoc will dispose of it for you.
The token parameter must be a valid OpenDoc token; you can call the IsODToken method to check whether a token is valid.

EXCEPTIONS

kODErrNotAnODToken
The specified token is not an OpenDoc token.

SEE ALSO
The ODNameResolver::IsODToken method (page 425).
"Returning Tokens" on page 428 in OpenDoc Programmer's Guide.
Table 11-1 on page 466 in OpenDoc Programmer's Guide.